27 Database as a Service Family APIs

This chapter describes the resource models for Database as a Service (DBaaS) API, Schema as a Service APIs, and the REST request/response interactions.The following topics are covered:

Resource Model for Database as a Service
Supported Operations for DBaaS Resources
Database as a Service API Examples
Resource Model for Schema as a Service
Supported Operations for Schema as a Service Resources
Schema as a Service API Examples
Using EMCLI to Create Database Profiles

Resource Model for Database as a Service

Cloud resources are organized by common service entities and specific services (for example, Database as a Service) provide resources by extending these common service entities. The figure below shows the DBaaS resource model:

Figure 27-1 Database as a Service Resource Model

The following sections describe the resources that are supported by the Database as a Service family type and provide examples of supported operations. The following resource models are described.

DB Zone
DBPlatformTemplate
DBPlatformInstance

DB Zone

This extends application/oracle.com.cloud.common.Zone. This resource represents the view of a Paas Infrastructure Zone that supports DBaaS resources. DB Zone has the following media type and payload:

Media Type: application/oracle.com.cloud.common.DbZone+json
Supported Payload: json
URI Format: /em/cloud/dbaas/zone/<zone id>

The following table describes the DB Zone Data Model.

Table 27-1 DB Zone Data Model

Field	Type	Occurs	Description
uri	URI	1	A GET against this URI refreshes the client representation of the Zone definition to this user.
name	String	1	Name of the Zone. SHALL be a UNICODE string to support different languages.
description	String	0..1	Human readable description of the Zone. SHALL be a UNICODE string to support different languages.
resource_state	ResourceState	1	The resource state of the resource.
context_id	String	1	Zone GUID
resource_state	ResourceState	1	The resource state of the resource.
service_family_type	String	1	The name of the service family type that this zone is associated with. It is "dbaas" for this.
templates	Collection <ServiceTemplate>	1	Collection of the service templates that this zone supports and can be deployed into. Currently, DBPlatformTemplate is the only supported type.
service_instances	Collection <ServiceInstance>	1	Collection of the service instances that are created in this zone.
media_type	String	1	The media type of the resource.
canonicalLink	URI	1	Can be used to perform cloud interactions like GET and POST.

DBPlatformTemplate

The DBPlatformTemplate extends the ServiceTemplate resource. This resource represents service templates created for creating databases. The databases may be created using profiles created using database templates, rman backups, and SnapClone. It is permissible to accept the ServiceTemplate media type on an instance of DBPlatformTemplate. It is a preconfigured deployable service that realizes a DBPlatformInstance resource. DBPlatformTemplate has the following media type and payload:

Media Type: application/oracle.com.cloud.common.DbPlatformTemplate+json
Supported Payload: json
URI Format: /em/cloud/dbaas/dbplatformtemplate/<template id>

The following table describes the DBPlatformTemplate Data Model.

Table 27-2 DBPlatformTemplate Data Model

Field	Type	Occurs	Description
uri	URI	1	A GET against this URI refreshes the client representation of the resources accessible to this user.
name	String	1	A human readable name given to the template.
description	String	0..1	A brief description given to the template
resource_state	ResourceState	1	The validity of the fields on a GET should be guaranteed only when the resource state is READY. Otherwise, the client should not assume the validity of the fields.
service_family_type	String	1	Denotes the type of Service Template. For example, "dbaas".
service_instances	Collection <DBPlatformInstance>	1	All service instances created based on this DBPlatformTemplate.
media_type	String	1	The media type of the service template that this type represents.
created	Timestamp	1	Date and time, in ISO 8601 format, when the template was created/last modified.
zones	Collection <DbZone>	1	List of all zones on which this service template is published
db_type	String	1	Type of the Database when provisioned. It can have one of the two values: "oracle_database" and "rac_database".
instance_configurable_params	String[]	1	List of parameters required to provision a DbPlatformInstance from this template. Username and Password in this case.
type	String	1	The type of the service template which is "dbaas" by default.
node_count		0..1	Number of Nodes. Implicit 1 for SI DB and explicit count for the RAC Db types.
canonicalLink	URI	1	Can be used to perform cloud interactions like GET and POST
deployment_params	List<Object>	1	Description of the parameters (username and password) which are required while creating a service instance.
subtype	String	1	The sub type of the instance created based on this template. It has a value "db" in this case.
context_id	URI	1	The unique id of the template.

DBPlatformInstance

The DBPlatformInstance extends the ServiceInstance resource. It is linked to an Oracle Database Instance or Cluster Database target in Enterprise Manager Cloud Control. DBPlatformInstance has the following media type and payload:

This section contains the following sections:

Media Type: application/oracle.com.cloud.common.DbPlatformInstance+json
Supported Payload: json
URI Format: /em/cloud/dbaas/dbplatforminstance/byrequest/<request id>

The following table describes the DBPlatformInstance Data Model.

Table 27-3 DBPlatformInstance Data Model

Field	Type	Occurs	Description
uri	URI	1	A GET against this URI refreshes the client representation of the resources accessible to this user.
name	String	1	A human readable name given to the instance. [POST]
destination_zone	Zone	1	The Zone to which the instance is deployed. [POST]
media_type	String	1	Indicates the additional media type that clients can use to perform a GET.
available_space	Float	0..1	Available space for this database instance.
resource_state	ResourceState	1	The validity of the fields on a GET should be guaranteed only when the resource state is READY. Otherwise, the client should not assume the validity of the fields.
based_on	DbPlatformTemplate	1	The db platform template on which this instance is published.
connect_string	String	0..1	Connect String required to establish a connection to this database instance.
created	String	1	Time of creation.
type	String	0..1	Type of the database : "oracle_database" for SIDB and "rac_database" for RAC
status	String	1	Status of the Database instance.
db_version	String	0..1	Version of the Database.
last_backup	Timestamp	0..1	Time at which the last backup of this database was taken.
load	Float	0..1	Current average active sessions of this instance.
master_username	String	1	Name of the master user of this database.
total_sessions	Integer	0..1	Total number of sessions for this database
total_sga	Float	0..1	Total SGA for this database.
up_time	String	1	Uptime in hours for the Service Instance.
context_id	String	1	The request id of this instance.
canonicalLink	URI	1	Can be used to perform cloud interactions like GET and DELETE for this instance.
instances	List<Object>	0..1	List all the node level details of the database instance (exists only when the type is "rac_database")
total_memory*	String	0..1	Total memory used by the instance (node).
active_sessions*	Float	0..1	Current average active sessions for this instance (node).
cpu_utilization*	Percentage	0..1	CPU utilization of this instance (node).
db_time*	Float	0..1	Database time of this instance (node).
cpu_count*	Integer	0..1	Number of CPU cores on the host on which the instance (node) is deployed.
allocated_sessions*	Integer	0..1	Number of sessions currently allocated.
name*	String	0..1	Name of the node (exists as an field in the list of "instances" field).

Note:

* In the case of database instance type "oracle_database", these fields exist as it is in the DBPlatformInstance Data model. In the case of type "rac_database", these fields exist as part of "instances" field and occur for each node of the database instance.

Supported Operations for DBaaS Resources

The following table lists all the operations that are supported on the various Database as a Service resources.

Table 27-4 Supported Operations

Resource	Operations (GET, POST, PUT, and DELETE)
Cloud	GET
Service Family Type	GET
DB Zone	GET, POST
DB Platform Template [Service Template]	GET, POST
DB Platform Instance [Service Instance]	GET, DELETE

Database as a Service API Examples

The following sections provide examples of interaction with Enterprise Manager Cloud Control 12.1.0.2 with Cloud Application plug-in 12.1.0.4 and higher. The following examples are covered:

Cloud
Filtering Output for Specific Resource Attributes
Service Family Type Resource
Service Instance Type resource
Zone
DB Platform Template Resource
Creating Databases
Polling the Database Creation
Deleting a Database Instance

Cloud

Use the top level /em/cloud to introspect the Cloud resource.

URL

https://example.us.oracle.com/em/cloud
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=X-specification-Version: 10001
Method

GET

The following returns the Cloud resource:

{
  "uri": "/em/cloud",
  "name": "Oracle Cloud by Enterprise Manager",
  "description": "This represents the Cloud resource of the Oracle Enterprise Manager Cloud Management solution",
  "resource_state": {
    "state": "READY"
  },
  "media_type": "application/oracle.com.cloud.common.Cloud+json",
  "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud",
  "zones": {
    "media_type": "application/oracle.com.cloud.common.Zone+json",
    "total": "4",
    "elements": [
      {
        "uri": "/em/cloud/jaas/zone/9708491651C090AB4B847C2F3CD177DE",
        "name": "SLC00ECXY_ZONE",
        "media_type": "application/oracle.com.cloud.jaas.Zone+json",
        "service_family_type": "jaas",
        "type": "jaas",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/jaas/zone/9708491651C090AB4B847C2F3CD177DE"
      },
      {
        "uri": "/em/cloud/jaas/zone/B329742A13BE0D63703BF0C0E4F98FB9",
        "name": "SLC01NBV_ZONE",
        "media_type": "application/oracle.com.cloud.jaas.Zone+json",
        "service_family_type": "jaas",
        "type": "jaas",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/jaas/zone/B329742A13BE0D63703BF0C0E4F98FB9"
      },
      {
        "uri": "/em/cloud/dbaas/zone/9708491651C090AB4B847C2F3CD177DE",
        "name": "SLC00ECXY_ZONE",
        "description": "",
        "media_type": "application/oracle.com.cloud.common.DbZone+json",
        "service_family_type": "dbaas",
        "type": "self_service_zone",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/zone/9708491651C090AB4B847C2F3CD177DE"
      },
      {
        "uri": "/em/cloud/dbaas/zone/B329742A13BE0D63703BF0C0E4F98FB9",
        "name": "SLC01NBV_ZONE",
        "description": "SLC01NBV_ZONE",
        "media_type": "application/oracle.com.cloud.common.DbZone+json",
        "service_family_type": "dbaas",
        "type": "self_service_zone",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/zone/B329742A13BE0D63703BF0C0E4F98FB9"
      }
    ]
  },
  "service_templates": {
    "media_type": "application/oracle.com.cloud.common.ServiceTemplate+json",
    "total": "2",
    "elements": [
      {
        "uri": "/em/cloud/dbaas/dbplatformtemplate/DEC94FE6D49DAA21E040F20A60511D14",
        "name": "SLC01NBV_SNAPCLONE_ST",
        "description": "",
        "media_type": "application/oracle.com.cloud.common.DbPlatformTemplate+json",
        "service_family_type": "dbaas",
        "type": "dbaas",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatformtemplate/DEC94FE6D49DAA21E040F20A60511D14"
      },
      {
        "uri": "/em/cloud/dbaas/dbplatformtemplate/DECCA0E18357F28DE040F20A60514D49",
        "name": "SLC00ECXY_DBCA_ST",
        "description": "",
        "media_type": "application/oracle.com.cloud.common.DbPlatformTemplate+json",
        "service_family_type": "dbaas",
        "type": "dbaas",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatformtemplate/DECCA0E18357F28DE040F20A60514D49"
      }
    ]
  },
  "service_family_types": {
    "media_type": "application/oracle.com.cloud.common.ServiceFamilyType+json",
    "total": "4",
    "elements": [
      {
        "uri": "/em/cloud/service_family_type/jaas",
        "name": "jaas",
        "media_type": "application/oracle.com.cloud.common.ServiceFamilyType+json",
        "type": "jaas",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/service_family_type/jaas"
      },
      {
        "uri": "/em/cloud/service_family_type/dbaas",
        "name": "dbaas",
        "media_type": "application/oracle.com.cloud.common.ServiceFamilyType+json",
        "type": "dbaas",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/service_family_type/dbaas"
      },
      {
        "uri": "/em/cloud/service_family_type/opc",
        "name": "opc",
        "media_type": "application/oracle.com.cloud.common.ServiceFamilyType+json",
        "type": "opc",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/service_family_type/opc"
      },
      {
        "uri": "/em/cloud/service_family_type/iaas",
        "name": "iaas",
        "media_type": "application/oracle.com.cloud.iaas.IaasServiceFamilyType+json",
        "type": "iaas",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/service_family_type/iaas"
      }
    ]
  },
  "service_requests": {
    "media_type": "application/oracle.com.cloud.common.Request+json",
    "total": "1",
    "elements": [
      {
        "uri": "/em/cloud/request/DEC87CE5B1DA175DE040F20A605150F8",
        "name": "SLC01NBV_DBCA_ST - Mon Jun 10 00:20:08 PDT 2013_CREATE_20_25",
        "media_type": "application/oracle.com.cloud.common.Request+json",
        "status": "SUCCESS",
        "lifecycle_type": "CREATE",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/request/DEC87CE5B1DA175DE040F20A605150F8"
      }
    ]
  }
}

Note:

Even though the Accept type was not specified, the Web service still unambiguously returns the Cloud resource as the "/em/cloud" address uniquely identifies the Cloud as the default resource to be returned.

Filtering Output for Specific Resource Attributes

The following shows interaction with the Cloud resource picking up specific attributes:

URL

https://example.us.oracle.com/em/cloud?service_family_types,name
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
Method

GET

Here are the selective attributes:

{
  "name": "Oracle Cloud by Enterprise Manager",
  "service_family_types": {
    "media_type": "application/oracle.com.cloud.common.ServiceFamilyType+json",
    "total": "4",
    "elements": [
      {
        "uri": "/em/cloud/service_family_type/jaas",
        "name": "jaas",
        "media_type": "application/oracle.com.cloud.common.ServiceFamilyType+json",
        "type": "jaas",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/service_family_type/jaas"
      },
      {
        "uri": "/em/cloud/service_family_type/dbaas",
        "name": "dbaas",
        "media_type": "application/oracle.com.cloud.common.ServiceFamilyType+json",
        "type": "dbaas",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/service_family_type/dbaas"
      },
      {
        "uri": "/em/cloud/service_family_type/opc",
        "name": "opc",
        "media_type": "application/oracle.com.cloud.common.ServiceFamilyType+json",
        "type": "opc",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/service_family_type/opc"
      },
      {
        "uri": "/em/cloud/service_family_type/iaas",
        "name": "iaas",
        "media_type": "application/oracle.com.cloud.iaas.IaasServiceFamilyType+json",
        "type": "iaas",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/service_family_type/iaas"
      }
    ]
  }
}

This feature is supported on all the common resources where only selective attributes will be gathered and returned to the client.

Service Family Type Resource

The following describes the Service Family Type resource.

URL

https://example.us.oracle.com/em/cloud/service_family_type/dbaas
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
Method

GET

The following shows the returned headers and content for this interaction:

X-specification-version: 10001
Content-Type: application/oracle.com.cloud.common.ServiceFamilyType+json; charset=ISO-8859-1
{
  "uri": "/em/cloud/service_family_type/dbaas",
  "name": "dbaas",
  "resource_state": {
    "state": "READY"
  },
  "media_type": "application/oracle.com.cloud.common.ServiceFamilyType+json",
  "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/service_family_type/dbaas",
  "type": "dbaas",
  "service_templates": {
    "media_type": "application/oracle.com.cloud.common.ServiceTemplate+json",
    "total": "2",
    "elements": [
      {
        "uri": "/em/cloud/dbaas/dbplatformtemplate/DEC94FE6D49DAA21E040F20A60511D14",
        "name": "SLC01NBV_SNAPCLONE_ST",
        "description": "",
        "media_type": "application/oracle.com.cloud.common.DbPlatformTemplate+json",
        "service_family_type": "dbaas",
        "type": "dbaas",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatformtemplate/DEC94FE6D49DAA21E040F20A60511D14"
      },
      {
        "uri": "/em/cloud/dbaas/dbplatformtemplate/DECCA0E18357F28DE040F20A60514D49",
        "name": "SLC00ECXY_DBCA_ST",
        "description": "",
        "media_type": "application/oracle.com.cloud.common.DbPlatformTemplate+json",
        "service_family_type": "dbaas",
        "type": "dbaas",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatformtemplate/DECCA0E18357F28DE040F20A60514D49"
      }
    ]
  },
  "zones": {
    "media_type": "application/oracle.com.cloud.common.Zone+json",
    "total": "2",
    "elements": [
      {
        "uri": "/em/cloud/dbaas/zone/9708491651C090AB4B847C2F3CD177DE",
        "name": "SLC00ECXY_ZONE",
        "description": "",
        "media_type": "application/oracle.com.cloud.common.DbZone+json",
        "service_family_type": "dbaas",
        "type": "self_service_zone",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/zone/9708491651C090AB4B847C2F3CD177DE"
      },
      {
        "uri": "/em/cloud/dbaas/zone/B329742A13BE0D63703BF0C0E4F98FB9",
        "name": "SLC01NBV_ZONE",
        "description": "SLC01NBV_ZONE",
        "media_type": "application/oracle.com.cloud.common.DbZone+json",
        "service_family_type": "dbaas",
        "type": "self_service_zone",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/zone/B329742A13BE0D63703BF0C0E4F98FB9"
      }
    ]
  },
  "instance_types": {
    "media_type": "application/oracle.com.cloud.common.InstanceType+json",
    "total": "1",
    "elements": [
      {
        "uri": "/em/cloud/instance_type/dbPlatformInstance%40dbaas",
        "name": "dbPlatformInstance",
        "description": "Db Instance",
        "media_type": "application/oracle.com.cloud.common.InstanceType+json",
        "instance_media_type": "application/oracle.com.cloud.common.DbPlatformInstance+json",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/instance_type/dbPlatformInstance%40dbaas"
      }
    ]
  },
  "service_requests": {
    "media_type": "application/oracle.com.cloud.common.Request+json",
    "total": "1",
    "elements": [
      {
        "uri": "/em/cloud/request/DEC87CE5B1DA175DE040F20A605150F8",
        "name": "SLC01NBV_DBCA_ST - Mon Jun 10 00:20:08 PDT 2013_CREATE_20_25",
        "media_type": "application/oracle.com.cloud.common.Request+json",
        "status": "SUCCESS",
        "lifecycle_type": "CREATE",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/request/DEC87CE5B1DA175DE040F20A605150F8"
      }
    ]
  }
}

The media type application/oracle.com.cloud.common.ServiceFamilyType+json is returned automatically as the most detailed resource.

Service Instance Type resource

This is the resource that describes the type of services that are provided by a particular Service Family Type.

URL

https://example.us.oracle.com/em/cloud/instance_type/dbPlatformInstance%40dbaas
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
Method

GET

The following shows the Service Instance Type resource:

{
  "uri" : "/em/cloud/instance_type/dbPlatformInstance%40dbaas" ,
  "name" : "dbPlatformInstance" ,
  "description" : "Db Instance" ,
  "media_type" : "application/oracle.com.cloud.common.InstanceType+json" ,
  "instance_media_type" : "application/oracle.com.cloud.common.DbPlatformInstance+json" , ,
  "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/instance_type/dbPlatformInstance%40dbaas"
}

Zone

This describes the Zone resource.

URL

https://example.us.oracle.com/em/cloud/dbaas/zone/82CF1C28FA20A183C99D138FF8065F19
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
Method

GET

The following is the Zone resource, automatically cast to the application/oracle.com.cloud.common.DbZone+json media type:

{
  "uri" : "/em/cloud/dbaas/zone/B49F86387B81DAED9A3D672D722CF29D" ,
  "name" : "RAC SSAZONE" ,
  "description" : "SSA Zone with RAC Nodes" ,
  "resource_state" :     {
      "state" : "READY"
    } ,
  "context_id" : "B49F86387B81DAED9A3D672D722CF29D" ,
  "media_type" : "application/oracle.com.cloud.common.DbZone+json" ,
  "service_family_type" : "dbaas" ,
  "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/zone/B49F86387B81DAED9A3D672D722CF29D" ,
  "type" : "self_service_zone" ,
  "service_instances" :     {
      "media_type" : "application/oracle.com.cloud.common.DbPlatformInstance+json" ,
      "total" : "1" ,
      "elements" : 
      [
          {
            "uri" : "/em/cloud/dbaas/dbplatforminstance/byrequest/1" ,
            "name" : "db000000.mycompany.com" ,
            "media_type" : "application/oracle.com.cloud.common.DbPlatformInstance+json" ,
            "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatforminstance/byrequest/1" ,
            "type" : "rac_database"
          }
      ]
    } ,
  "templates" :     {
      "media_type" : "application/oracle.com.cloud.common.DbPlatformTemplate+json" ,
      "total" : "1" ,
      "elements" : 
      [
          {
            "uri" : "/em/cloud/dbaas/dbplatformtemplate/DE039DAC33FFEA6FE040E80A687848A6" ,
            "name" : "12101_RACFileSystem_ServiceTemplate" ,
            "description" : "12101 RAC FileSystem Service Template" ,
            "media_type" : "application/oracle.com.cloud.common.DbPlatformTemplate+json" ,
            "service_family_type" : "dbaas" ,
            "type" : "dbaas" ,
            "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatformtemplate/DE039DAC33FFEA6FE040E80A687848A6"
          }
      ]
    }
}

DB Platform Template Resource

As shown in previous examples, the elements in the collection shown all have "media_type" as an attribute to clearly indicate what its resource type is.

URL

https://example.oracle.com/em/cloud/dbaas/dbplatformtemplate/CC3BBB665A6BC6FFE040F00AEF252456
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
Method

GET

This is the resource returned as the complete DbPlatformTemplate resource:

{
  "uri" : "/em/cloud/dbaas/dbplatformtemplate/DE039DAC33FFEA6FE040E80A687848A6" ,
  "name" : "12101_RACFileSystem_ServiceTemplate" ,
  "description" : "12101 RAC FileSystem Service Template" ,
  "resource_state" :     {
      "state" : "READY"
    } ,
  "media_type" : "application/oracle.com.cloud.common.DbPlatformTemplate+json" ,
  "service_family_type" : "dbaas" ,
  "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatformtemplate/DE039DAC33FFEA6FE040E80A687848A6" ,
  "type" : "dbaas" ,
  "created" : "2013-05-31T12:35:20+0000" ,
  "zones" :     {
      "media_type" : "application/oracle.com.cloud.common.DbZone+json" ,
      "total" : "1" ,
      "elements" : 
      [
          {
            "uri" : "/em/cloud/dbaas/zone/B49F86387B81DAED9A3D672D722CF29D" ,
            "name" : "RAC SSAZONE" ,
            "description" : "SSA Zone with RAC Nodes" ,
            "context_id" : "B49F86387B81DAED9A3D672D722CF29D" ,
            "media_type" : "application/oracle.com.cloud.common.DbZone+json" ,
            "service_family_type" : "dbaas" ,
            "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/zone/B49F86387B81DAED9A3D672D722CF29D" ,
            "type" : "self_service_zone"
          }
      ]
    } ,
  "service_instances" :     {
      "media_type" : "application/oracle.com.cloud.common.DbPlatformInstance+json" ,
      "total" : "1" ,
      "elements" : 
      [
          {
            "uri" : "/em/cloud/dbaas/dbplatforminstance/byrequest/1" ,
            "name" : "db000000.mycompany.com" ,
            "media_type" : "application/oracle.com.cloud.common.DbPlatformInstance+json" ,
            "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatforminstance/byrequest/1" ,
            "type" : "rac_database"
          }
      ]
    } ,
  "deployment_params" : 
  [
      {
        "name" : "username" ,
        "description" : "Master account Username" ,
        "type" : "STRING" ,
        "require" : "true" ,
        "sensitive" : "false"
      } ,
      {
        "name" : "password" ,
        "description" : "Password for the Master account" ,
        "type" : "STRING" ,
        "require" : "true" ,
        "sensitive" : "true"
      }
  ] ,
  "subtype" : "db" ,
  "db_type" : "rac_database" ,
  "node_count" : "2" ,
  "instance_configurable_params" :     {
      "username" : "" ,
      "password" : ""
    }
}

Creating Databases

This section describes how to create a service instance using the Cloud resources. As DB is a service instance in the service family type "dbaas", you need to identify the zone of the same family type in which to create the DB. There are two approaches to creating a DB:

POST to the Db Zone on which the database is to reside
POST to the DbPlatformTemplate of which the database is to be based on

Note the attributes in the submitted body for the POST. The pattern is the same for other service instance creations. Because the intention is clear, the "zone" attribute is not required while POSTing to the Db Zone. Similarly, the "based_on" attribute is not needed when POSTing to the DbPlatformTemplate. The following operations are described:

POST to the Db Zone
POST to the DbPlatformTemplate

POST to the Db Zone

The following shows the configuration for POSTing to the Db Zone:

URL

https://example.oracle.com/em/cloud/dbaas/zone/82CF1C28FA20A183C99D138FF8065F19
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=

Content-Type: application/oracle.com.cloud.common.DbPlatformInstance+json

Accept: application/oracle.com.cloud.common.DbPlatformInstance+json

Body

{
       "based_on": "/em/cloud/dbaas/dbplatformtemplate/CC3BBB665A6BC6FFE040F00AEF252456",
       "name": "<Request name>",
       "description": "<Request Description>",
       "params":
       { 
            "username": "Master Account username for the DB",
            "password": "Password for the Master Account on the DB"
       }
  }

Method

POST

The following is the response from the above interaction:

{
  "uri" : "/em/cloud/dbaas/dbplatforminstance/byrequest/22" ,
  "name" : "Test_create_intance" ,
  "resource_state" :     {
      "state" : "INITIATED"
    } ,
  "media_type" : "application/oracle.com.cloud.common.DbPlatformInstance+json" ,
  "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatforminstance/byrequest/22" ,
  "status" : "SCHEDULED"
}

POST to the DbPlatformTemplate

The following describes the configuration for POSTing to the DbPlatformTemplate:

URL

https://example.oracle.com/em/cloud/dbaas/dbplatformtemplate/CC3BBB665A6BC6FFE040F00AEF252456
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=

Content-Type: application/oracle.com.cloud.common.DbPlatformInstance+json

Accept: application/oracle.com.cloud.common.DbPlatformInstance+json

Body

{
     "zone": "/em/cloud/dbaas/zone/82CF1C28FA20A183C99D138FF8065F19",
       "name": "<Request name>",
       "description": "<Request Description>",
       "params":
       { 
            "username": "Master Account username for the DB",
            "password": "Password for the Master Account on the DB"
       }
}

Method

POST

The following is the response from the above interaction:

{
  "uri" : "/em/cloud/dbaas/dbplatforminstance/byrequest/22" ,
  "name" : "Test_create_intance" ,
  "resource_state" :     {
      "state" : "INITIATED"
    } ,
  "media_type" : "application/oracle.com.cloud.common.DbPlatformInstance+json" ,
  "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatforminstance/byrequest/23" ,
  "status" : "SCHEDULED"
}

This response is the same as the previous version. If the zone is not specified, then it is not possible for the Web service to determine where the DB should be deployed.

Polling the Database Creation

Once the database creation has been POSTed, you can GET the resource identified by the return URI to keep track of the status.

URL

https://example.oracle.com/em/cloud/dbaas/dbplatforminstance/byrequest/7
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=

Accept: application/oracle.com.cloud.common.DbPlatformInstance+json
Method

GET

The following is the response:

{
    "uri": "/em/cloud/dbaas/dbplatforminstance/byrequest/22",
    "name": "Test_create_intance_CREATE_55_42",
    "description": "Create Database for test.",
    "resource_state":
    {
      "state": "CREATING"
    },
    "context_id": "22",
    "media_type": "application/oracle.com.cloud.common.DbPlatformInstance+json",
    "status": "IN_PROGRESS",
    "created": "2013-06-07 23:09:04" ,
    "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatforminstance/byrequest/22"
}

Note that the "resource_state" attribute is showing "CREATING" state to indicate that the database is still being created. Once the database is created, the same GET will return the database resource with "READY" state, as shown below:

{
  "uri" : "/em/cloud/dbaas/dbplatforminstance/byrequest/22" ,
  "name" : "db000000.mycompany.com" ,
  "resource_state" :     {
      "state" : "READY"
    } ,
  "context_id" : "22" ,
  "media_type" : "application/oracle.com.cloud.common.DbPlatformInstance+json" ,
  "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatforminstance/byrequest/22" ,
  "status" : "RUNNING" ,
  "created" : "2013-06-07 23:14:04" ,
  "based_on" : "/em/cloud/dbaas/dbplatformtemplate/DE9845B82981CF0CE040E80AD87838C9" ,
  "connect_string" : "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=cluster-r)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=db000000.mycompany.com)))" ,
  "type" : "rac_database" ,
  "destination_zone" : "/em/cloud/dbaas/zone/B49F86387B81DAED9A3D672D722CF29D" ,
  "up_time" : "0" ,
  "load" : "0.1801962347135334" ,
  "total_sessions" : "155" ,
  "total_sga" : "4778.5546875" ,
  "available_space" : "0.68255615234375" ,
  "instances" :
  [
      {
        "name" : "db000000.mycompany.com_db0000001" ,
        "total_memory" : "2672.286 MB" ,
        "active_sessions" : ".037" ,
        "cpu_utilization" : "1.106" ,
        "db_time" : "3.66" ,
        "cpu_count" : "2" ,
        "allocated_sessions" : "63"
      } ,
      {
        "name" : "db000000.mycompany.com_db0000002" ,
        "total_memory" : "2676.052 MB" ,
        "active_sessions" : ".144" ,
        "cpu_utilization" : "4.225" ,
        "db_time" : "14.359" ,
        "cpu_count" : "2" ,
        "allocated_sessions" : "65"
      }
  ] ,
  "last_backup" : "null" ,
  "master_username" : "InstanceUser1" ,
  "db_version" : "11.2.0.3.0"
}

The output in case of single instance database (type:oracle_database) :

{
  "uri" : "/em/cloud/dbaas/dbplatforminstance/byrequest/23" ,
  "name" : "sidb0001.host1.mycompany.com" ,
  "resource_state" :     {
      "state" : "READY"
    } ,
  "context_id" : "23" ,
  "media_type" : "application/oracle.com.cloud.common.DbPlatformInstance+json" ,
  "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatforminstance/byrequest/23" ,
  "status" : "RUNNING" ,
  "created" : "2013-06-09 07:56:57" ,
  "based_on" : "/em/cloud/dbaas/dbplatformtemplate/DEB2BDE2F773E356E040E50AD2E56BE9" ,
  "connect_string" : "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=host1.mycompany.com)(PORT=1521)))(CONNECT_DATA=(SID=sidb0001)))" ,
  "type" : "oracle_database" ,
  "destination_zone" : "/em/cloud/dbaas/zone/DEB2E2920C20D2E1E040E50AD2E56BEF" ,
  "up_time" : "0" ,
  "load" : "0.156456056384199" ,
  "total_sessions" : "46" ,
  "total_sga" : "398.203125" ,
  "available_space" : "0.19097900390625" ,
  "last_backup" : "null" ,
  "master_username" : "InstanceUser1" ,
  "db_version" : "11.2.0.1.0" ,
  "active_sessions" : ".156" ,
  "cpu_utilization" : "5.35" ,
  "db_time" : "15.646" ,
  "cpu_count" : "1" ,
  "allocated_sessions" : "39" ,
  "total_memory" : "524.384 MB"
}

Deleting a Database Instance

The DELETE request on the URI of the resource can be issued to delete a DB Service Instance. For example, the following DELETE request is issued:

URL

https://example.oracle.com/em/em/cloud/dbaas/dbplatforminstance/byrequest/7
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=

Accept: application/oracle.com.cloud.common.DbPlatformInstance+json
Method

DELETE

The following Web service response with code 200 is returned:

{
  "uri" : "/em/cloud/dbaas/dbplatforminstance/byrequest/22" ,
  "name" : "db000000.mycompany.com" ,
  "resource_state" :     {
      "state" : "DESTROYING" ,
      "messages" :
      [
          {
            "text" : "Submit 'DELETE' operation on 'application/oracle.com.cloud.common.DbPlatformInstance+json' 'db000000.mycompany.com'.  The process has job id '41'" ,
            "date" : "2013-06-07T23:16:20+0000"
          }
      ]
    } ,
  "context_id" : "22" ,
  "media_type" : "application/oracle.com.cloud.common.DbPlatformInstance+json" ,
  "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatforminstance/byrequest/22" ,
  "type" : "rac_database"
}

After some time, the GET request on the database URI will result in the following interaction:

URL

https://example.oracle.com/em/cloud/dbaas/dbplatforminstance/byrequest/7
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
Method

GET

The Web service returns the following:

{
  "uri" : "/em/cloud/dbaas/dbplatforminstance/byrequest/23" ,
  "name" : "sidb0001.host1.mycompany.com" ,
  "resource_state" :     {
      "state" : "DESTROYING"
    } ,
  "context_id" : "23" ,
  "media_type" : "application/oracle.com.cloud.common.DbPlatformInstance+json" ,
  "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/dbplatforminstance/byrequest/23" ,
  "status" : "RUNNING" ,
  "created" : "2013-06-09 07:56:57" ,
  "based_on" : "/em/cloud/dbaas/dbplatformtemplate/DEB2BDE2F773E356E040E50AD2E56BE9" ,
  "connect_string" : "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=host1.mycompany.com)(PORT=1521)))(CONNECT_DATA=(SID=sidb0001)))" ,
  "type" : "oracle_database" ,
  "destination_zone" : "/em/cloud/dbaas/zone/DEB2E2920C20D2E1E040E50AD2E56BEF" ,
  "up_time" : "0" ,
  "load" : "0.156456056384199" ,
  "total_sessions" : "46" ,
  "total_sga" : "398.203125" ,
  "available_space" : "0.19097900390625" ,
  "last_backup" : "null" ,
  "master_username" : "InstanceUser1" ,
  "db_version" : "11.2.0.1.0" ,
  "active_sessions" : ".156" ,
  "cpu_utilization" : "5.35" ,
  "db_time" : "15.646" ,
  "cpu_count" : "1" ,
  "allocated_sessions" : "39" ,
  "total_memory" : "524.384 MB"
}

The "status" of the databse will be "DELETED" once the database is DELETED.

Resource Model for Schema as a Service

This section describes the resource model for Schema as a Service (SchaaS) API and the REST request/response interactions. The following topics are covered:

Resource Model for Schema as a Service

Cloud resources are organized by common service entities, and specific services (for example, Schema as a Service) provide resources by extending these common service entities. The figure below shows the SchaaS resource model.

Figure 27-2 Schema as a Service Resource Model

The following sections describe the resources that are supported by the Schema as a Service APIs and provide examples of supported operations. The following resource models are described:

Schema PlatformTemplate
SchemaPlatformInstance

Schema as a Service uses the same Cloud, Service Family, and DB Zone resources as described in Resource Model for Database as a Service.

Schema PlatformTemplate

The SchemaPlatformTemplate extends the ServiceTemplate resource. It represents the service template created for Schema Service creation. It can be a template for creating a schema service using profile based schemas (schema with data) or for creating a schemas service containing empty schemas.

It is permissible to accept the ServiceTemplate media type on an instance of SchemaPlatformTemplate. It is a preconfigured deployable service that realizes a SchemaPlatformInstance resource. SchemaPlatformTemplate has the following media type and payload:

Media Type: application/oracle.com.cloud.common.SchemaPlatformTemplate
Supported Payload: json
URI Format: /em/cloud/dbaas/schemaplatformtemplate/<template id>

The following table describes the SchemaPlatformTemplate Data Model.

Table 27-5 SchemaPlatformTemplate Data Model

Field	Type	Occurs	Description
uri	URI	1	A GET against this URI refreshes the client representation of the resources accessible to this user.
name	String	1	A human readable name given to the template.
description	String	0..1	A brief description given to the template.
created	Timestamp	1	Date and time, in ISO 8601 format, when the template was created/last modified.
resource_state	ResourceState	1	The validity of the fields on a GET should be guaranteed only when the resource state is READY. Otherwise, the client should not assume the validity of the fields.
zones	Collection <DbZone>	0..1	List of all zones configured for this template.
service_instances	Collection <SchemaPlatformInstance>	0..1	All service instances created based on this SchemaPlatformTemplate.
media_type	String	1	The media type of the service template that this type represents.
canonicalLink	URI	1	Can be used to perform cloud interactions like GET and POST.
params	Object	1	List of parameters required to provision a Schema Platform Instance from this template.
deployment_params	List<Object>	1	Description of the parameters which are required while creating a service instance.
type	String	1	The type of the service template which is "dbaas" by default.
subtype	String	1	The sub type of the instance created based on this template. It has a value "schema" in this case.
template_type	String	1	Type of this template based on how the template got created. It can have any of two values : "EMPTY_SCHEMAS" or "SCHEMAS_FROM_PROFILE".
max_number_of_schemas	Integer	0..1	Maximum number of schemas that can be created in a single instance request. This field exists only if template_type is "EMPTY_SCHEMAS".
workloads	List<Object>	0..1	List all the workloads defined for this template and list the attributes for each one of them.

SchemaPlatformInstance

The SchemaPlatformInstance extends the ServiceInstance resource. It is linked to Oracle Database Service target in Enterprise Manager Cloud Control. SchemaPlatformInstance has the following media type and payload:

Media Type: application/oracle.com.cloud.common.SchemaPlatformInstance
Supported Payload: json
URI Format: /em/cloud/dbaas/schemaplatforminstance/byrequest/<request id>

The following table describes the SchemaPlatformInstance Data Model:

Table 27-6 SchemaPlatformInstance Data Model

Field	Type	Occurs	Description
uri	URI	1	A GET against this URI refreshes the client representation of the resources accessible to this user.
name	String	1	A human readable name given given to the database service[POST]
destination_zone	Zone	1	The Zone to which the database service is deployed [POST]
created	Timestamp	1	Date and time, in ISO 8601 format, when the template was created/last modified.
resource_state	ResourceState	1	The validity of the fields on a GET should be guaranteed only when the resource state is READY. Otherwise, the client should not assume the validity of the fields.
based_on	SchemaPlatformTemplate	1	The schema platform template on which this database service is published.
media_type	String	1	Indicates the additional media type that clients can use to perform a GET.
canonicalLink	URI	1	Can be used to perform cloud interactions like GET and POST.
type	String	1	Type of the database service. It has the default value "oracle_dbsvc".
connect_string	String	0..1	Connect String required to establish a connection to this database service.
status	String	1	Status of the database service.
db_version	String	0..1	Version of the database on which this service is running.
context_id	String	1	The request id of this database service.

Supported Operations for Schema as a Service Resources

The following table lists all the operations that are supported on the various Schema as a Service resources.

Table 27-7 Supported Operations

Resource	Operations (GET, POST, PUT, and DELETE)
Cloud	GET
Service Family Type	GET
DB Zone	GET, POST
Schema Platform Template [Service Template]	GET, POST
Schema Platform Instance [Service Instance]	GET, DELETE

Schema as a Service API Examples

The following sections provide examples of interaction with Enterprise Manager Cloud Control 12.1.0.3 with Cloud Application plug-in 12.1.0.6 and higher. The examples for GET on cloud, GET on dbaas family type and GET on Db Zone are covered in the Dbaas APIs section. The following examples are covered:

Schema Platform Template Resource
Creating Database Services

Schema Platform Template Resource

As shown in previous examples (in DbaaS), the elements in the collection showed, all have "media_type" as an attribute to clearly indicate what its resource type is.

URL

https://example.mycompany.com/em/cloud/dbaas/schemaplatformtemplate/CC3BBB665A6BC6FFE040F00AEF252456
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
Method

GET

This is the resource returned as the complete SchemaPlatformTemplate resource:

{
  "uri": "/em/cloud/dbaas/schemaplatformtemplate/DE3F8D882F132F45E040F00AAA2330C5",
  "name": "Template Schema Si",
  "description": "",
  "resource_state": {
    "state": "READY"
  },
  "media_type": "application/oracle.com.cloud.common.SchemaPlatformTemplate+json",
  "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/schemaplatformtemplate/DE3F8D882F132F45E040F00AAA2330C5",
  "type": "dbaas",
  "created": "2013-06-03T11:51:20+0000",
  "zones": {
    "media_type": "application/oracle.com.cloud.common.DbZone+json",
    "total": "1",
    "elements": [
      {
        "uri": "/em/cloud/dbaas/zone/34C1FC23A7503E1CC9C490C9670635F9",
        "name": "Zone Si",
        "description": "",
        "context_id": "34C1FC23A7503E1CC9C490C9670635F9",
        "media_type": "application/oracle.com.cloud.common.DbZone+json",
        "service_family_type": "dbaas",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/zone/34C1FC23A7503E1CC9C490C9670635F9",
        "type": "self_service_zone"
      }
    ]
  },
  "service_instances": {
    "media_type": "application/oracle.com.cloud.common.SchemaPlatformInstance+json",
    "total": "1",
    "elements": [
      {
        "uri": "/em/cloud/dbaas/schemaplatforminstance/byrequest/61",
        "name": "Service_1_2AEE494EE0994",
        "media_type": "application/oracle.com.cloud.common.SchemaPlatformInstance+json",
        "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/schemaplatforminstance/byrequest/61",
        "target_type": "oracle_dbsvc"
      }
    ]
  },
  "deployment_params": [
    {
      "name": "masterAccount",
      "description": "Master account schema. Not Required for the SCHEMAS_FROM_PROFILE Schema templates",
      "type": "STRING",
      "require": "false",
      "sensitive": "false"
    },
    {
      "name": "service_name_prefix",
      "description": "Prefix for the service name instances",
      "type": "STRING",
      "require": "true",
      "sensitive": "false"
    },
    {
      "name": "workload_name",
      "description": "WorkLoad name to be associated with the request",
      "type": "STRING",
      "require": "true",
      "sensitive": "false"
    },
    {
      "name": "schema",
      "description": "List of schema to be created",
      "type": "LIST",
      "defaultValue": [
        {
          "name": "username",
          "description": "New schema name",
          "type": "STRING",
          "require": "true",
          "sensitive": "false"
        },
        {
          "name": "original_name",
          "description": "Original schema name. Required only for the SCHEMAS_FROM_PROFILE Schema templates",
          "type": "STRING",
          "require": "false",
          "sensitive": "false"
        },
        {
          "name": "password",
          "description": "Password for the schema",
          "type": "STRING",
          "require": "true",
          "sensitive": "true"
        }
      ],
      "require": "true",
      "sensitive": "false"
    }
  ],
  "subtype": "schema",
  "template_type": "EMPTY_SCHEMAS",
  "max_number_of_schemas": "4",
  "workloads": [
    {
      "name": "WL_112",
      "description": "null",
      "attributes": [
        {
          "name": "CPU",
          "value": "0.1",
          "units": "cores"
        },
        {
          "name": "Memory",
          "value": "0.1",
          "units": "GB"
        },
        {
          "name": "Storage",
          "value": "10",
          "units": "GB"
        }
      ]
    }
  ],
  "params": {
    "masterAccount": "",
    "service_name_prefix": "",
    "workload_name": "",
    "schema": [
      {
        "username": "",
        "password": ""
      },
      {
        "username": "",
        "password": ""
      }
    ]
  }
}

Creating Database Services

This section describes how to create a database service using the Cloud resources. As Database service is also a service instance in the service family type "dbaas", you need to identify the zone of the same family type in which to create the database service. There are two approaches to creating a database service:

POST to the Db Zone on which db service is to be created
POST to the SchemaPlatformTemplate of which the database service is to be based on

Note the attributes in the submitted body for the POST. The pattern is the same for other service instance creations. Because the intention is clear, the "zone" attribute is not required while POSTing to the Db Zone. Similarly, the "based_on" attribute is not needed when POSTing to the SchemaPlatformTemplate. The following operations are described:

POST to the Db Zone
POST on SchemaPlatformTemplate
Polling the Schema Service Creation
Deleting a Schema Service

POST to the Db Zone

The following shows the configuration for creating a Schema Service Instance

URL

https://example.mycompany.com/em/cloud/dbaas/zone/82CF1C28FA20A183C99D138FF8065F19
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=

Content-Type: application/oracle.com.cloud.common.SchemaPlatformInstance+json

Accept: application/oracle.com.cloud.common.SchemaPlatformInstance+json

Body for a Profile Based Schema Template

{
    "based_on": "/em/cloud/dbaas/schemaplatformtemplate/DE3F8D882F132F45E040F00AAA2330C5",
    "name": "TestRequest",
    "params": {
        "workload_name": "WL_112",
        "service_name_prefix": "Service_1",
        "masterAccount": " SchemaUser1",
        "schema": [
            {
                "username": " SchemaUser1",
                "password": "welcome1"
            },
            {
                "username": " SchemaUser2",
                "password": "welcome1"
            }
        ]
    }
}

Method

POST

The following is the response from the above interaction:

{
  "uri" : "/em/cloud/dbaas/schemaplatforminstance/byrequest/22" ,
  "name" : "TestRequest" ,
  "resource_state" :     {
      "state" : "INITIATED"
    } ,
  "media_type" : "application/oracle.com.cloud.common.SchemaPlatformInstance+json" ,
  "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/schemaplatforminstance/byrequest/22" ,
  "status" : "SCHEDULED"
}

POST on SchemaPlatformTemplate

The following shows the configuration for creating a Schema Service Instance

URL

https://example.mycompany.com/em/cloud/dbaas/schemaplatformtemplate/CC3BBB665A6BC6FFE040F00AEF252456
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=

Content-Type: application/oracle.com.cloud.common.SchemaPlatformInstance+json

Accept: application/oracle.com.cloud.common.SchemaPlatformInstance+json

Body for a Profile Based Schema Template

{
    "zone": "/em/cloud/dbaas/zone/34C1FC23A7503E1CC9C490C9670635F9",
    "name": "TestRequest",
    "params": {
        "workload_name": "WL_112",
        "service_name_prefix": "Service_1",
        "masterAccount": "SchemaUser1",
        "schema": [
            {
                "username": "SchemaUser1",
                "password": "welcome"
            },
            {
                "username": "SchemaUser2",
                "password": "welcome"
            }
        ]
    }
}

Method

POST

The following is the response from the above interaction:

{
  "uri" : "/em/cloud/dbaas/schemaplatforminstance/byrequest/23" ,
  "name" : "TestRequest" ,
  "resource_state" :     {
      "state" : "INITIATED"
    } ,
  "media_type" : "application/oracle.com.cloud.common.SchemaPlatformInstance+json" ,
  "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/schemaplatforminstance/byrequest/23" ,
  "status" : "SCHEDULED"
}

This response is the same as the previous version. If the zone is not specified, then it is not possible for the Web service to determine where the database service should be deployed.

Polling the Schema Service Creation

Once the database service creation has been POSTed, you can GET the resource identified by the return URI to keep track of the status.

URL

https://example.mycompany.com/em/cloud/dbaas/schemaplatforminstance/byrequest/22
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=

Accept: application/oracle.com.cloud.common.SchemaPlatformInstance+json
Method

GET

The following is the response:

{
    "uri": "/em/cloud/dbaas/schemaplatforminstance/byrequest/22",
    "name": "TestRequest_CREATE_55_42",
    "description": "Create Service for test.",
    "resource_state":
    {
      "state": "CREATING"
    },
    "context_id": "22",
    "media_type": "application/oracle.com.cloud.common.SchemaPlatformInstance+json",
    "status": "IN_PROGRESS",
    "created": "2013-06-07 23:09:04" ,
    "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/schemaplatforminstance/byrequest/22"
}

Note that the "resource_state" attribute is showing "CREATING" state to indicate the database Service is still being created. Once the database service is created, the same GET will return the database service resource with "READY" state, as shown below:

{
  "uri": "/em/cloud/dbaas/schemaplatforminstance/byrequest/22",
  "name": "Service_1_35E576F22E97E",
  "resource_state": {
    "state": "READY"
  },
  "context_id": "2",
  "media_type": "application/oracle.com.cloud.common.SchemaPlatformInstance+json",
  "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/schemaplatforminstance/byrequest/2",
  "status": "RUNNING",
  "created": "2013-06-10 02:45:32",
  "based_on": "/em/cloud/dbaas/schemaplatformtemplate/DECA1100F797EF10E040F00AFBB123E7",
  "type": "oracle_dbsvc",
  "connect_string": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=host1.mycompany.com)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=Service_1_35E576F22E97E.mycompany.com)))",
  "destination_zone": "/em/cloud/dbaas/zone/34C1FC23A7503E1CC9C490C9670635F9",
  "db_version": "11.2.0.3.0"
}

Deleting a Schema Service

The DELETE request on the URI of the resource can be issued to delete a database service. For example, the following DELETE request is issued:

URL

https://example.mycompany.com/em/cloud/dbaas/schemaplatforminstance/byrequest/22
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=

Accept: application/oracle.com.cloud.common.SchemaPlatformInstance+json
Method

DELETE

The following Web service response with code 200 is returned:

{
  "uri" : "/em/cloud/dbaas/schemaplatforminstance/byrequest/22" ,
  "name" : "Service_1_35E576F22E97E" ,
  "resource_state" :     {
      "state" : "DESTROYING" ,
      "messages" :
      [
          {
            "text" : "Submit 'DELETE' operation on 'application/oracle.com.cloud.common.SchemaPlatformInstance+json' 'Service_1_35E576F22E97E'.  The process has job id '41'" ,
            "date" : "2013-06-07T23:16:20+0000"
          }
      ]
    } ,
  "context_id" : "22" ,
  "media_type" : "application/oracle.com.cloud.common.SchemaPlatformInstance +json" ,
  "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/schemaplatforminstance/byrequest/22" ,
  "type" : "oracle_dbsvc"
}

After some time, the GET request on the database service URI will result in the following interaction:

URL

https://example.mycompany.com/em/cloud/dbaas/schemaplatforminstance/byrebyrequest/22
Headers

Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
Method

GET

The Web service returns the following:

{
  "uri": "/em/cloud/dbaas/schemaplatforminstance/byrequest/22",
  "name": "Service_1_35E576F22E97E",
  "resource_state": {
    "state": "DESTROYING"
  },
  "context_id": "2",
  "media_type": "application/oracle.com.cloud.common.SchemaPlatformInstance+json",
  "canonicalLink": "/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/schemaplatforminstance/byrequest/2",
  "status": "RUNNING",
  "created": "2013-06-10 02:45:32",
  "based_on": "/em/cloud/dbaas/schemaplatformtemplate/DECA1100F797EF10E040F00AFBB123E7",
  "type": "oracle_dbsvc",
  "connect_string": "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=host1.mycompany.com)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=Service_1_35E576F22E97E.mycompany.com)))",
  "destination_zone": "/em/cloud/dbaas/zone/34C1FC23A7503E1CC9C490C9670635F9",
  "db_version": "11.2.0.3.0"
}

Please note the status of the database service will be DELETED once the schema service is deleted.

Using EMCLI to Create Database Profiles

This section explains the different Database Provisioning Profiles used in Database as a Service and Schema as a Service. It also explains how these profiles can be created using the EMCLI verbs exposed in the 12.1.0.3 database plug-in. The following topics are covered:

About Database Provisioning Profile T ypes
Creating Provisioning Profiles using EMCLI
Sample EMCLI Property Files

About Database Provisioning Profile T ypes

The following are the four types of Database provisioning profiles used in Database as a Service and Schema as a Service:

DBCA Template
RMAN
Snapclone
Schema

DBCA Template

The DBCA template supports both structure plus data and structure only types. This database provisioning profile is created from the production or source database registered with Enterprise Manager.

Note:

Structure and data requires a shutdown of the database. It should be used for very small databases (< 50GB).

RMAN

This data content of this database provisioning profile comprises the RMAN Backup pieces. Any of the following methods can be used to create the RMAN profile:

Hot RMAN Backup

This option is enabled only when the archive log mode on the source database is turned ON.
Cold RMAN Backup

In this case, the source database is brought down to take the RMAN backup
Existing Backup

This option can be used when the RMAN backup is already taken on the source and you want to use one of the existing RMAN backups to create a profile.
Existing Backup pieces when there is no access to the source database

Create profile source database using existing backup pieces when there is no access to the source database. This option can be used when the RMAN backup is already taken on the source and kept in a known location. This option is only supported using EMCLI.

Snapclone

The data content of this database provisioning profile is derived from Snapshot information on the Filer (NetApp or SunZFS filer) of all the volumes where the datafiles for the source database are kept.

Schema

The data content of this database provisioning profile is compiled from an export dump created using the Data Pump tool. You can choose to export Schema objects (structure only) or the Schema with data (structure + data).

Note that you cannot export empty schemas or include Oracle schemas (these schemas are not available for selection). Schemas that are filtered out are listed below:

Table 27-8 Filtered Out Schema

ANONYMOUS	DMSYS	OASPUBLIC	OWBSYS	TSMSYS
APEX_030200	EXFSYS	ODM	OWBSYS_AUDIT	WEBSYS
APEX_PUBLIC_USER	FLOWS_	ODM_MTR	SCOTT	WK_PROXY
APPQOSSYS	FLOWS_03000	OLAPSYS	SI_INFORMTN_SCHEMA	WK_TEST
AURORA$JIS$UTILITY$	FLOWS_FILES	ORACLE_OCM	SPATIAL_CSW_ADMIN_USR	WKPROXY
AURORA$ORB$UNAUTHENTICATED	LBACSYS	ORDDATA	SPATIAL_WFS_ADMIN_USR	WKSYS
BI	MDDATA	ORDPLUGINS	SYS	WMSYS
CTXSYS	MDSYS	ORDSYS	SYSMAN	XDB
DBSNMP	MGMT_VIEW	OSE$HTTP$ADMIN	SYSTEM	XS$NULL
DIP	MTSSYS	OUTLN	TRACESRV

Creating Provisioning Profiles using EMCLI

This method allows the administrators or cloud provisioning operators to create the database provisioning profile using EMCLI verbs. The following is the syntax of the verb introduced in the 12.1.0.3 database plug-in:

emcli create_dbprofile -input_file=data:<Prop file name>

This command takes in a property file that completely describes the type of profile that will be created and the options used.

Sample EMCLI Property Files

The following sections provide sample EMCLI property files for the database provisioning profiles:

DBCA Template
New RMAN Backup from the Source Database
Existing RMAN Backup from the Source Database
Existing RMAN Backup on the Stage Location
Snapclone Database
Schema Database

DBCA Template

Table 27-9 EMCLI Property Files for DBCA Template

Name	Required	Description	Variable
Reference Database	true	The source database from which the profile will be created	REFERENCE_DATABASE=
Type of the reference database	true	The target type of the source database (oracle_database or rac_database)	REFERENCE_DATABASE_TYPE=
Reference Node	false	The reference node from which the profile will be created. Applicable only for RAC and Cluster targets	REF_NODE_SELECTED=
Backup mechanism for data	false	Variable to identify what mode needs to be used for creating backup data. Possible values are EXPORT, DBCA_TEMPLATE, RMAN, THIN_PROVISIONING	DATA_CONTENT_MODE=DBCA_TEMPLATE
The content that will be included in the backup	false	The data content that gets included in the backup can metadata or data. Possible values are METADATA_ONLY and METADATA_AND_DATA.	DATA_CONTENT=METADATA_AND_DATA
Reference Host Credentials	true	The credentials that will be used for OS authentication. Format is <Cred Name:Owner>. If this is not provided,preferred credentials will be checked against NormalHostCreds.	REF_HOST_CREDENTIALS=
Database Credentials	false	The credentials that will be used for performing database authentication. Format is <Cred Name:Owner>. If this is not provided, preferred credentials will be checked against SysDbaCreds	REF_DB_CREDENTIALS=
Convert to OFA format	false	Converts to the OFA format	CONVERT_TO_OFA=
Profile Name	true	Name of the profile	PROFILE_NAME=
Profile Description	false	Name with which the profile should be created.	PROFILE_DESC=
Profile location	true	Location of the profile in software library	PROFILE_LOCATION=
Profile Version	false	Version of the profile. If none is specified, the Database version shall be used.	PROFILE_VERSION=
Profile Vendor	false	Vendor of the profile. Default is Oracle.	PROFILE_VENDOR=
Profile notes	false	Notes for the profile.	PROFILE_NOTES=
Working Directory	false	Working directory is the location where the files are staged.	WORKING_DIRECTORY=
Is the profile initiated by end user	true	Is the profile initiated by end user as part of backup process or the database.	USER_INITIATED=false

New RMAN Backup from the Source Database

Table 27-10 EMCLI Property Files for a New RMAN Backup

Name	Required	Description	Variable
Reference Database	true	The source database from which the profile will be created	REFERENCE_DATABASE=
Type of the reference database	true	The target type of the source database (oracle_database or rac_database)	REFERENCE_DATABASE_TYPE=
Reference Node	false	The reference node from which the profile will be created. Applicable only for RAC and Cluster targets	REF_NODE_SELECTED=
Backup mechanism for data	false	Variable to identify what mode needs to be used for creating backup data. Possible values are EXPORT, DBCA_TEMPLATE, RMAN, and THIN_PROVISIONING	DATA_CONTENT_MODE=RMAN
The content that will be included in the backup	false	The data content that gets included in the backup can metadata or data. Possible values are METADATA_ONLY and METADATA_AND_DATA.	DATA_CONTENT=METADATA_AND_DATA
Reference Host Credentials	true	The credentials that will be used for OS authentication. Format is <Cred Name:Owner>. If this is not provided,preferred credentials will be checked against NormalHostCreds.	REF_HOST_CREDENTIALS=
Database Credentials	false	The credentials that will be used for performing database authentication. Format is <Cred Name:Owner>. If this is not provided, preferred credentials will be checked against SysDbaCreds	REF_DB_CREDENTIALS=
Profile Name	true	Name of the profile	PROFILE_NAME=
Profile Description	false	Name with which the profile should be created.	PROFILE_DESC=
Profile location	true	Location of the profile in software library	PROFILE_LOCATION=
Profile Version	false	Version of the profile. If none is specified, the Database version shall be used.	PROFILE_VERSION=
Profile Vendor	false	Vendor of the profile. Default is Oracle.	PROFILE_VENDOR=
Profile notes	false	Notes for the profile.	PROFILE_NOTES=
Working Directory	false	Working directory is the location where the files are staged.	WORKING_DIRECTORY=
Is the profile initiated by end user	true	Is the profile initiated by end user as part of backup process or the database.	USER_INITIATED=false
Is Database target available	false	Is Database target available. Must be set to 'true' for this use case.	DB_TARGET_AVAILABLE=true
Backup Type	false	Backup type.	RMAN.BACKUP_TYPE=
Number of RMAN Channels to use(Default No of Channels : 2	false	Number of Channels to be used. Possible Values: like 1, 2 or 3.	RMAN.RMAN_CHANNELS=
Retain backup until	false	Retain backup until. Format: mm/dd/yyyy.	RMAN.RETAIN_UNTIL=
Encryption Type	false	Encryption Type. Possible Values: ON, OFF.	RMAN.ENCRYPTION_TYPE=
Encryption Password/Key	false	Encryption key which was used to encrypt the backup.	RMAN.ENCRYPTION_PASSWORD=
Compression Type	false	Compression type. Possible Values: HIGH, MEDIUM, LOW.	RMAN.COMPRESSION_TYPE=
RMAN Backup Location	true	Location of the RMAN Backups.	RMAN.RMAN_BACKUP_LOCATION=
Backup file format	false	Backup file format.	RMAN.BACKUP_FILE_FORMAT=
Backup file tag	false	Backup file tag.	RMAN.BACKUP_FILE_TAG=
Source: Control File Location	false	Location of the Control File.	RMAN.CONTROL_FILE_NAME=
Control File Tag	false	Control File Tag.	RMAN.CONTROL_FILE_TAG=
Source: Database SID	false	Database SID of the source database.	RMAN.ORACLE_DB_SID=
Initialize File Name	false	Initialize file name.	RMAN.INIT_FILE_NAME=
User List File Name	false	Name of the users list file. this file should be kept in location specified for RMAN_BACKUP_LOCATION.	RMAN.USERLIST_FILE_NAME=
GDB Name of source Db	false	GDB Name of source Db.	RMAN.DATABASE_NAME=
use existing RMAN Backup	true	use existing RMAN Backup. This should be set to 'NO' for this use case.	RMAN.USE_EXISTING_BACKUP=NO

Existing RMAN Backup from the Source Database

Table 27-11 EMCLI Property Files for a Existing RMAN Backup

Name	Required	Description	Variable
Reference Database	true	The source database from which the profile will be created	REFERENCE_DATABASE=
Type of the reference database	true	The target type of the source database (oracle_database or rac_database)	REFERENCE_DATABASE_TYPE=
Reference Node	false	The reference node from which the profile will be created. Applicable only for RAC and Cluster targets	REF_NODE_SELECTED=
Backup mechanism for data	false	Variable to identify what mode needs to be used for creating backup data. Possible values are EXPORT, DBCA_TEMPLATE, RMAN, and THIN_PROVISIONING	DATA_CONTENT_MODE=RMAN
The content that will be included in the backup	false	The data content that gets included in the backup can metadata or data. Possible values are METADATA_ONLY and METADATA_AND_DATA.	DATA_CONTENT=METADATA_AND_DATA
Reference Host Credentials	true	The credentials that will be used for OS authentication. Format is <Cred Name:Owner>. If this is not provided,preferred credentials will be checked against NormalHostCreds.	REF_HOST_CREDENTIALS=
Database Credentials	false	The credentials that will be used for performing database authentication. Format is <Cred Name:Owner>. If this is not provided, preferred credentials will be checked against SysDbaCreds	REF_DB_CREDENTIALS=
Profile Name	true	Name of the profile	PROFILE_NAME=
Profile Description	false	Name with which the profile should be created.	PROFILE_DESC=
Profile location	true	Location of the profile in software library.	PROFILE_LOCATION=
Profile Version	false	Version of the profile. If none is specified, the Database version shall be used.	PROFILE_VERSION=
Profile Vendor	false	Vendor of the profile. Default is Oracle.	PROFILE_VENDOR=
Profile notes	false	Notes for the profile.	PROFILE_NOTES=
Working Directory	false	Working directory is the location where the files are staged.	WORKING_DIRECTORY=
Is the profile initiated by end user	true	Is the profile initiated by end user as part of backup process or the database.	USER_INITIATED=false
Is Database target available	false	Is Database target available. Must be set to 'true' for this use case.	DB_TARGET_AVAILABLE=true
Platform Name of Source Database	false	Platform Name of Source Database. For example, Linux x86-64 or Oracle Solaris on x86-64 (64-bit).	SOURCE_DB_PLATFORM_NAME=
Backup Type	false	Backup type.	RMAN.BACKUP_TYPE=
Number of RMAN Channels to use(Default No of Channels : 2	false	Number of Channels to be used. Possible Values: like 1, 2 or 3.	RMAN.RMAN_CHANNELS=
Retain backup until	false	Retain backup until. Format: mm/dd/yyyy.	RMAN.RETAIN_UNTIL=
Encryption Type	false	Encryption Type. Possible Values: ON, OFF.	RMAN.ENCRYPTION_TYPE=
Source:Encryption Password/Key	false	Encryption key which was used to encrypt the backup.	RMAN.ENCRYPTION_PASSWORD=
Compression Type	false	Compression type. Possible Values: HIGH, MEDIUM, LOW.	RMAN.COMPRESSION_TYPE=
RMAN Backup Location	true	Location of the RMAN Backups.	RMAN.RMAN_BACKUP_LOCATION=
Backup file format	false	Backup file format.	RMAN.BACKUP_FILE_FORMAT=
Backup file tag	false	Backup file tag.	RMAN.BACKUP_FILE_TAG=
Source: Control File Location	false	Location of the Control File.	RMAN.CONTROL_FILE_NAME=
Control File Tag	false	Control File Tag.	RMAN.CONTROL_FILE_TAG=
Source: Database SID	false	Database SID of the source database.	RMAN.ORACLE_DB_SID=
Initialize File Name	false	Initialize file name.	RMAN.INIT_FILE_NAME=
User List File Name	false	Name of the users list file. this file should be kept in location specified for RMAN_BACKUP_LOCATION.	RMAN.USERLIST_FILE_NAME=
GDB Name of source Db	false	GDB Name of source Db.	RMAN.DATABASE_NAME=
use existing RMAN Backup	true	use existing RMAN Backup. This should be set to 'YES' for this use case.	RMAN.USE_EXISTING_BACKUP=YES

Existing RMAN Backup on the Stage Location

Table 27-12 EMCLI Property Files for a Existing RMAN Backup on the Stage Location

Name	Required	Description	Variable
Reference Database	true	The source database from which the profile will be created	REFERENCE_DATABASE=
Type of the reference database	true	The target type of the source database (oracle_database or rac_database)	REFERENCE_DATABASE_TYPE=
Reference Node	false	The reference node from which the profile will be created. Applicable only for RAC and Cluster targets	REF_NODE_SELECTED=
Backup mechanism for data	false	Variable to identify what mode needs to be used for creating backup data. Possible values are EXPORT, DBCA_TEMPLATE, RMAN, and THIN_PROVISIONING	DATA_CONTENT_MODE=RMAN
The content that will be included in the backup	false	The data content that gets included in the backup can metadata or data. Possible values are METADATA_ONLY and METADATA_AND_DATA.	DATA_CONTENT=METADATA_AND_DATA
Reference Host Credentials	true	The credentials that will be used for OS authentication. Format is <Cred Name:Owner>. If this is not provided,preferred credentials will be checked against NormalHostCreds.	REF_HOST_CREDENTIALS=
Database Credentials	false	The credentials that will be used for performing database authentication. Format is <Cred Name:Owner>. If this is not provided, preferred credentials will be checked against SysDbaCreds	REF_DB_CREDENTIALS=
Profile Name	true	Name of the profile	PROFILE_NAME=
Profile Description	false	Name with which the profile should be created.	PROFILE_DESC=
Profile location	true	Location of the profile in software library.	PROFILE_LOCATION=
Profile Version	false	Version of the profile. If none is specified, the Database version shall be used.	PROFILE_VERSION=
Profile Vendor	false	Vendor of the profile. Default is Oracle.	PROFILE_VENDOR=
Profile notes	false	Notes for the profile.	PROFILE_NOTES=
Working Directory	false	Working directory is the location where the files are staged.	WORKING_DIRECTORY=
Is the profile initiated by end user	true	Is the profile initiated by end user as part of backup process or the database.	USER_INITIATED=false
Is Database target available	false	Is Database target available. Must be set to 'false' for this use case.	DB_TARGET_AVAILABLE=false
Platform Name of Source Database	false	Platform Name of Source Database. For example, Linux x86-64 or Oracle Solaris on x86-64 (64-bit).	SOURCE_DB_PLATFORM_NAME=
Backup Type	false	Backup type.	RMAN.BACKUP_TYPE=
Number of RMAN Channels to use(Default No of Channels : 2	false	Number of Channels to be used. Possible Values: like 1, 2 or 3.	RMAN.RMAN_CHANNELS=
Retain backup until	false	Retain backup until. Format: mm/dd/yyyy.	RMAN.RETAIN_UNTIL=
Encryption Type	false	Encryption Type. Possible Values: ON, OFF.	RMAN.ENCRYPTION_TYPE=
Source:Encryption Password/Key	false	Encryption key which was used to encrypt the backup.	RMAN.ENCRYPTION_PASSWORD=
Compression Type	false	Compression type. Possible Values: HIGH, MEDIUM, LOW.	RMAN.COMPRESSION_TYPE=
RMAN Backup Location	true	Location of the RMAN Backups.	RMAN.RMAN_BACKUP_LOCATION=
Backup file format	false	Backup file format. Possible Values: %U	RMAN.BACKUP_FILE_FORMAT=
Source: Control File Location	false	Location of the Control File.	RMAN.CONTROL_FILE_NAME=
Control File Tag	false	Control File Tag. Default: control01.ctl	RMAN.CONTROL_FILE_TAG=
Source: Database SID	false	Database SID of the source database.	RMAN.ORACLE_DB_SID=
Initialize File Name	false	Initialize file name.	RMAN.INIT_FILE_NAME=
User List File Name	false	Name of the users list file. this file should be kept in location specified for RMAN_BACKUP_LOCATION.	RMAN.USERLIST_FILE_NAME=
GDB Name of source Db	false	GDB Name of source Db.	RMAN.DATABASE_NAME=
RMDB Version	false	RMDBS version	RMAN.DATABASE_VERSION=

Snapclone Database

Table 27-13 EMCLI Property Files for Snapclone Database

Name	Required	Description	Variable
Reference Database	true	The source database from which the profile will be created	REFERENCE_DATABASE=
Type of the reference database	true	The target type of the source database (oracle_database or rac_database)	REFERENCE_DATABASE_TYPE=
Reference Node	false	The reference node from which the profile will be created. Applicable only for RAC and Cluster targets	REF_NODE_SELECTED=
Backup mechanism for data	false	Variable to identify what mode needs to be used for creating backup data. Possible values are EXPORT, DBCA_TEMPLATE, RMAN, and THIN_PROVISIONING	DATA_CONTENT_MODE=THIN_PROVISIONING
The content that will be included in the backup	false	The data content that gets included in the backup can metadata or data. Possible values are METADATA_ONLY and METADATA_AND_DATA.	DATA_CONTENT=METADATA_AND_DATA
Reference Host Credentials	true	The credentials that will be used for OS authentication. Format is <Cred Name:Owner>. If this is not provided,preferred credentials will be checked against NormalHostCreds.	REF_HOST_CREDENTIALS=
Database Credentials	false	The credentials that will be used for performing database authentication. Format is <Cred Name:Owner>. If this is not provided, preferred credentials will be checked against SysDbaCreds	REF_DB_CREDENTIALS=
Profile Name	true	Name of the profile	PROFILE_NAME=
Profile Description	false	Name with which the profile should be created.	PROFILE_DESC=
Profile location	true	Location of the profile in software library.	PROFILE_LOCATION=
Profile Version	false	Version of the profile. If none is specified, the Database version shall be used.	PROFILE_VERSION=
Profile Vendor	false	Vendor of the profile. Default is Oracle.	PROFILE_VENDOR=
Profile notes	false	Notes for the profile.	PROFILE_NOTES=
Working Directory	false	Working directory is the location where the files are staged.	WORKING_DIRECTORY=
Is the profile initiated by end user	true	Is the profile initiated by end user as part of backup process or the database.	USER_INITIATED=false

Schema Database

Table 27-14 EMCLI Property Files for Schema Database

Name	Required	Description	Variable
Reference Database	true	The source database from which the profile will be created	REFERENCE_DATABASE=
Type of the reference database	true	The target type of the source database (oracle_database or rac_database)	REFERENCE_DATABASE_TYPE=
Reference Node	false	The reference node from which the profile will be created. Applicable only for RAC and Cluster targets	REF_NODE_SELECTED=
Backup mechanism for data	false	Variable to identify what mode needs to be used for creating backup data. Possible values are EXPORT, DBCA_TEMPLATE, RMAN, and THIN_PROVISIONING	DATA_CONTENT_MODE=EXPORT
The content that will be included in the backup	false	The data content that gets included in the backup can metadata or data. Possible values are METADATA_ONLY and METADATA_AND_DATA.	DATA_CONTENT=METADATA_AND_DATA
Reference Host Credentials	true	The credentials that will be used for OS authentication. Format is <Cred Name:Owner>. If this is not provided,preferred credentials will be checked against NormalHostCreds.	REF_HOST_CREDENTIALS=
Database Credentials	false	The credentials that will be used for performing database authentication. Format is <Cred Name:Owner>. If this is not provided, preferred credentials will be checked against SysDbaCreds	REF_DB_CREDENTIALS=
Profile Name	true	Name of the profile	PROFILE_NAME=
Profile Description	false	Name with which the profile should be created.	PROFILE_DESC=
Profile location	true	Location of the profile in software library.	PROFILE_LOCATION=
Profile Version	false	Version of the profile. If none is specified, the Database version shall be used.	PROFILE_VERSION=
Profile Vendor	false	Vendor of the profile. Default is Oracle.	PROFILE_VENDOR=
Profile notes	false	Notes for the profile.	PROFILE_NOTES=
Data gold image name	true	Entity name of the data gold image	DATA_GOLD_IMAGE_ENTITY_NAME=
Working Directory	false	Working directory is the location where the files are staged.	WORKING_DIRECTORY=
Schemas to be exported	true	List of schemas that needs to be included as part of the export.	EXPORT.SCHEMA_INCLUDE_LIST.0=
Dump Directories	false	List of directory objects that needs to be used for storing export. Format: directory=dir1,file_name=file1%U.dmp[,max_size=1MB].	EXPORT.DUMP_DIRECTORY_LIST.0=
Log Directory	false	Log directory location where the log file generated during export.	PORT.LOG_FILE_DIRECTORY=
Degree of Parallelism	false	Degree of Parallelism indicates the number of threads. For example, 1 or 2 or 3...	EXPORT.DEGREE_OF_PARALLELISM=